---
layout: m1x_soap
title: Invoice List
---

<h2><a name="sales_order_invoice.list-Module%3AMageSales"></a>Module: Mage_Sales</h2>


<h4><a name="sales_order_invoice.list-Resource%3Asalesorderinvoice"></a>Resource: sales_order_invoice</h4>

<p><b>Aliases</b>:</p>
<ul>
	<li>order_invoice</li>
</ul>


<h5><a name="sales_order_invoice.list-Method%3A"></a>Method:</h5>

<ul>
	<li>sales_order_invoice.list (SOAP V1)</li>
	<li>salesOrderInvoiceList (SOAP V2)</li>
</ul>


<p>Allows you to retrieve the list of order invoices. Additional filters can also be applied.</p>

<p><b>Aliases</b>:</p>
<ul>
	<li>order_invoice.list</li>
</ul>


<p><b>Arguments</b>:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> sessionId <br class="atl-forced-newline" /> </td>
<td> Session ID </td>
</tr>
<tr>
<td> array </td>
<td> filters <br class="atl-forced-newline" /> </td>
<td> Array of filters for the list of invoices (optional) </td>
</tr>
</tbody></table>


<p><b>Returns</b>:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> array </td>
<td> result </td>
<td> Array of salesOrderInvoiceEntity </td>
</tr>
</tbody></table>


<p>The <b>salesOrderInvoiceEntity</b> content is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> increment_id <br class="atl-forced-newline" /> </td>
<td> Increment ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> created_at <br class="atl-forced-newline" /> </td>
<td> Date of invoice creation </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> order_currency_code <br class="atl-forced-newline" /> </td>
<td> Order currency code (e.g., EUR) </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> order_id <br class="atl-forced-newline" /> </td>
<td> Order ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> state <br class="atl-forced-newline" /> </td>
<td> Order state </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> grand_total <br class="atl-forced-newline" /> </td>
<td> Grand total amount invoiced </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> invoice_id <br class="atl-forced-newline" /> </td>
<td> Invoice ID </td>
</tr>
</tbody></table>




<h4><a name="sales_order_invoice.list-Examples"></a>Examples</h4>

<h5><a name="sales_order_invoice.list-RequestExampleSOAPV1"></a>Request Example SOAP V1</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div id="root">
		<pre class="theme: Default; brush: php; gutter: false">$client = new SoapClient('http://magentohost/api/soap/?wsdl');

// If somestuff requires api authentification,
// then get a session token
$session = $client-&gt;login('apiUser', 'apiKey');

$result = $client-&gt;call($session, 'sales_order_invoice.list');
var_dump($result);

// If you don't need the session anymore
//$client-&gt;endSession($session);</pre>
		</div>
</div></div>

<h5><a name="sales_order_invoice.list-RequestExampleSOAPV2%28ListofAllInvoices%29"></a>Request Example SOAP V2 (List of All Invoices)</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div id="root">
		<pre class="theme: Default; brush: php; gutter: false">$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
$sessionId = $proxy-&gt;login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary

$result = $proxy-&gt;salesOrderInvoiceList($sessionId);
var_dump($result);</pre>
		</div>
</div></div>

<h5><a name="sales_order_invoice.list-RequestExampleSOAPV2%28ComplexFilter%29"></a>Request Example SOAP V2 (Complex Filter)</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div id="root">
		<pre class="theme: Default; brush: php; gutter: false">$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');

// If some stuff requires api authentification,
// then get a session token
$session = $client-&gt;login('apiUser', 'apiKey');
$complexFilter = array(
    'complex_filter' =&gt; array(
        array(
            'key' =&gt; 'state',
            'value' =&gt; array('key' =&gt; 'in', 'value' =&gt; '2,3')
        )
    )
);
$result = $client-&gt;salesOrderInvoiceList($session, $complexFilter);

var_dump ($result);</pre>
		</div>
</div></div>



<h5><a name="sales_order_invoice.list-RequestExampleSOAPV2%28WSIComplianceMode%29"></a>Request Example SOAP V2 (WS-I Compliance Mode)</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div id="root">
		<pre class="theme: Default; brush: php; gutter: false">$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); 

$sessionId = $proxy-&gt;login((object)array('username' =&gt; 'apiUser', 'apiKey' =&gt; 'apiKey')); 
 
$result = $proxy-&gt;salesOrderInvoiceList((object)array('sessionId' =&gt; $sessionId-&gt;result));   
var_dump($result-&gt;result);</pre>
		</div>
</div></div>

<h5><a name="sales_order_invoice.list-ResponseExampleSOAPV1"></a>Response Example SOAP V1</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div id="root">
		<pre class="theme: Default; brush: java; gutter: false">array
  0 =&gt;
    array
      'order_id' =&gt; string '2' (length=1)
      'increment_id' =&gt; string '200000001' (length=9)
      'created_at' =&gt; string '2012-03-30 12:02:19' (length=19)
      'state' =&gt; string '2' (length=1)
      'grand_total' =&gt; string '384.9800' (length=8)
      'order_currency_code' =&gt; string 'USD' (length=3)
      'invoice_id' =&gt; null
  1 =&gt;
    array
      'order_id' =&gt; string '3' (length=1)
      'increment_id' =&gt; string '200000002' (length=9)
      'created_at' =&gt; string '2012-03-30 12:06:20' (length=19)
      'state' =&gt; string '2' (length=1)
      'grand_total' =&gt; string '339.9900' (length=8)
      'order_currency_code' =&gt; string 'USD' (length=3)
      'invoice_id' =&gt; null</pre>
		</div>
</div></div>

<?php include(__ROOT__ . 'footer.php'); ?>
